Markdown syntax
Markdown is a plain text format for writing web content that easily converts to HTML Hypertext Markup Language (HTML) is the standard markup language for creating web pages and web applications.. This topic is a quick overview of basic Markdown syntax, which you can use in the MemberXG administrator pages.
Using the Markdown language you can quickly write HTML web text with just a few extra characters. For example, the following Markdown text when written:
Welcome to the *Wonderful* employee site, where **you** can find healthcare information.
Becomes:
Welcome to the Wonderful employee site, where you can find healthcare information.
Paragraphs and line breaks
To write paragraphs, simply type one or more lines of text followed by one or more blank lines. Don’t indent or use tabs.
To create a line break, simply add two or more spaces and then press Enter
.
Format Chart
Format | Do this | To see this |
---|---|---|
Headings |
Type
|
Heading 1 Heading 2 |
Blockquote |
To create a blockquote, add a
|
Blockquote |
Strike through |
To strike through text, add two
|
|
Emphasize (Italics) |
Surround the text with one asterisk or an underscore (or press
|
text |
Bold |
Surround the text with two asterisks or underscores (or press
|
text |
Italics + Bold |
To make text both bold and italicize at the same time, add three asterisks or underscores before and after the text. ***text*** or___text___ |
text |
Numbered List |
Type |
|
Unordered List |
Type one of the following characters
|
|
Add an image
To add an image, add an exclamation mark !
followed by the alt text in brackets, and the path or uniform resource locator An address to a website or page on the Internet. It displays in your browser address bar. to the image file in parentheses. If you’d like, you can add a title surrounded by quotes after the URL. The image title displays as a tool tip.
![Flower](https://cdn.pixabay.com/photo/2018/06/01/08/22/cranesbill-3445890_960_720.jpg “Pretty Pink Flower”)
Links
Type the link name in brackets, followed by the path or URL in parentheses. [text to link](http://example.com/)
[MYbasys](https://www.basys.com/customer-cms/)
becomes MYbasys.
To display an email address as a link (or any other address), enclose the address in <>
brackets.<mailto:address@example.com>
displays as customer support@email.net.
Type characters, literally
Markdown allows you to use backslash escapes to generate literal characters that are used for Markdown’s formatting syntax. For example, if you wanted to surround a word with actual asterisks (instead of italics), you can use back slashes before the asterisks, like this: \literal asterisks\*
which becomes: *literal asterisks*.
Markdown provides back slash escapes for the following characters:
\
backslash
`
back tick
*
asterisk
_
underscore
{}
curly braces
[]
square brackets
()
parentheses
#
hash mark
+
plus sign
-
minus sign (hyphen)
.
dot
!
exclamation mark